KFbxAnimCurveKey Class Reference

#include
<kfbxanimcurve.h>

Inheritance diagram for KFbxAnimCurveKey:

[legend]

List of all members.

Detailed Description

Definition at line 323 of file kfbxanimcurve.h.


Public Member Functions
	KFbxAnimCurveKey ()
	Constructor with no argument.
	KFbxAnimCurveKey (KTime pTime)
	Constructor with time.
	KFbxAnimCurveKey (KTime pTime, float pVal)
	Constructor with time and value.
	KFbxAnimCurveKey (KFbxAnimCurveKey const &pFKey)
	Copy constructor.
	~KFbxAnimCurveKey ()
	Destructor.
KFbxAnimCurveKey &	operator= (const KFbxAnimCurveKey &pFKey)
	Assignment operator.
KTime	GetTime () const
	Get time value.
void	SetTime (const KTime &pTime)
	Set time value.
void	Set (KTime pTime, float pValue)
	Set time and value of key.
void	SetTCB (KTime pTime, float pValue, float pData0=0.0f, float pData1=0.0f, float pData2=0.0f)
	Set a key with cubic interpolation, TCB tangent mode.
float	GetValue () const
	Get key value.
void	SetValue (float pValue)
	Set key value.
KFbxAnimCurveDef::EInterpolationType	GetInterpolation ()
	Get key interpolation.
void	SetInterpolation (KFbxAnimCurveDef::EInterpolationType pInterpolation)
	Set key interpolation.
KFbxAnimCurveDef::ETangentMode	GetTangentMode (bool pIncludeOverrides=false)
	Get tangent mode.
void	SetTangentMode (KFbxAnimCurveDef::ETangentMode pTangentMode)
	Set tangent mode.
KFbxAnimCurveDef::EWeightedMode	GetTangentWeightMode () const
	Get key tangent weight mode.
void	SetTangentWeightMode (KFbxAnimCurveDef::EWeightedMode pTangentWeightMode, KFbxAnimCurveDef::EWeightedMode pMask=KFbxAnimCurveDef::eWEIGHTED_ALL)
	Set key tangent weight mode as double value (cubic interpolation, non TCB tangent mode).
KFbxAnimCurveDef::EVelocityMode	GetTangentVelocityMode () const
	Get key tangent velocity mode.
void	SetTangentVelocityMode (KFbxAnimCurveDef::EVelocityMode pTangentVelocityMode, KFbxAnimCurveDef::EVelocityMode pMask=KFbxAnimCurveDef::eVELOCITY_ALL)
	Set key tangent velocity mode as double value (cubic interpolation, non TCB tangent mode).
KFbxAnimCurveDef::EConstantMode	GetConstantMode () const
	Get key constant mode.
void	SetConstantMode (KFbxAnimCurveDef::EConstantMode pMode)
	Set constant mode.
float	GetDataFloat (KFbxAnimCurveDef::EKFbxAnimCurveDataIndex pIndex) const
	Get data float.
void	SetDataFloat (KFbxAnimCurveDef::EKFbxAnimCurveDataIndex pIndex, float pValue)
	Set data float.
void	SetTangentVisibility (KFbxAnimCurveDef::ETangentVisibility pVisibility)
	Set tangent visibility mode.
KFbxAnimCurveDef::ETangentVisibility	GetTangentVisibility () const
	Return tangent visibility mode.
void	SetBreak (bool pVal)
	Set/Unset Break tangent Only valid for User and Auto keys.
bool	GetBreak () const
	Get if tangent is break Only valid for User and Auto keys.
KFbxAnimCurveKeyImpl *	GetImpl () const
	Get key implementation.
Static Public Member Functions
static void	SetAllocatorFct (KFbxAnimCurveKeyImpl (pAllocatorFct)())
	Set allocator function.
static void	SetCopyAllocatorFct (KFbxAnimCurveKeyImpl (pCopyAllocatorFct)(KFbxAnimCurveKeyImpl *))
	Set copy allocator function.
static void	SetDeallocatorFct (void(pDeallocatorFct)(KFbxAnimCurveKeyImpl ))
	Set deallocator function.

Constructor & Destructor Documentation

KFbxAnimCurveKey ( ) [inline]

Constructor with no argument.

Definition at line 330 of file kfbxanimcurve.h.

References K_ASSERT, and NULL.

KFbxAnimCurveKey ( KTime pTime ) [inline]

Constructor with time.

Parameters:

pTime

The time of key.

Definition at line 339 of file kfbxanimcurve.h.

References K_ASSERT, NULL, and KFbxAnimCurveKeyBase::SetTime().

KFbxAnimCurveKey	(	KTime	pTime,
		float	pVal
	)			`[inline]`

Constructor with time and value.

Parameters:

	pTime	The time of key.
	pVal	The value of key.

Definition at line 350 of file kfbxanimcurve.h.

References K_ASSERT, and NULL.

KFbxAnimCurveKey ( KFbxAnimCurveKey const & pFKey ) [inline]

Copy constructor.

Definition at line 359 of file kfbxanimcurve.h.

References GetImpl(), GetTime(), K_ASSERT, NULL, and KFbxAnimCurveKeyBase::SetTime().

~KFbxAnimCurveKey ( ) [inline]

Destructor.

Definition at line 368 of file kfbxanimcurve.h.

References K_ASSERT, and NULL.

Member Function Documentation

KFbxAnimCurveKey& operator= ( const KFbxAnimCurveKey & pFKey ) [inline]

Assignment operator.

Definition at line 376 of file kfbxanimcurve.h.

References GetImpl(), GetTime(), K_ASSERT, and KFbxAnimCurveKeyBase::SetTime().

KTime GetTime ( ) const [inline, virtual]

Get time value.

Returns:: Time value.

Reimplemented from KFbxAnimCurveKeyBase.

Definition at line 390 of file kfbxanimcurve.h.

References KFbxAnimCurveKeyBase::GetTime().

Referenced by KFbxAnimCurveKey(), and operator=().

void SetTime ( const KTime & pTime ) [inline, virtual]

Set time value.

Parameters:

pTime

Time value to set.

Reimplemented from KFbxAnimCurveKeyBase.

Definition at line 398 of file kfbxanimcurve.h.

References KFbxAnimCurveKeyBase::SetTime().

void Set	(	KTime	pTime,
		float	pValue
	)			`[inline]`

Set time and value of key.

Parameters:

	pTime	New time of this key.
	pValue	New value of this key.

Definition at line 407 of file kfbxanimcurve.h.

References KFbxAnimCurveKeyBase::SetTime().

void SetTCB	(	KTime	pTime,
		float	pValue,
		float	pData0 = `0.0f`,
		float	pData1 = `0.0f`,
		float	pData2 = `0.0f`
	)			`[inline]`

Set a key with cubic interpolation, TCB tangent mode.

Parameters:

	pTime	Key time.
	pValue	Key value.
	pData0	Tension.
	pData1	Continuity.
	pData2	Bias.

Definition at line 420 of file kfbxanimcurve.h.

References KFbxAnimCurveKeyBase::SetTime().

float GetValue ( ) const [inline]

Get key value.

Returns:: Key value.

Definition at line 429 of file kfbxanimcurve.h.

void SetValue ( float pValue ) [inline]

Set key value.

Parameters:

pValue

Key value to set.

Definition at line 437 of file kfbxanimcurve.h.

KFbxAnimCurveDef::EInterpolationType GetInterpolation ( ) [inline]

Get key interpolation.

Returns:: Key interpolation.

Definition at line 445 of file kfbxanimcurve.h.

void SetInterpolation ( KFbxAnimCurveDef::EInterpolationType pInterpolation ) [inline]

Set key interpolation.

Parameters:

pInterpolation

Interpolation type to set.

Definition at line 453 of file kfbxanimcurve.h.

KFbxAnimCurveDef::ETangentMode GetTangentMode ( bool pIncludeOverrides = false ) [inline]

Get tangent mode.

Returns:: Tangent mode.

Definition at line 461 of file kfbxanimcurve.h.

void SetTangentMode ( KFbxAnimCurveDef::ETangentMode pTangentMode ) [inline]

Set tangent mode.

Parameters:

pTangentMode

Tangent mode to set.

Definition at line 469 of file kfbxanimcurve.h.

KFbxAnimCurveDef::EWeightedMode GetTangentWeightMode ( ) const [inline]

Get key tangent weight mode.

Warning: This method is meaningful for cubic interpolation only. Tangent weight modes are: KFCURVE_WEIGHTED_NONE, KFCURVE_WEIGHTED_RIGHT, KFCURVE_WEIGHTED_NEXT_LEFT, KFCURVE_WEIGHTED_ALL

Definition at line 481 of file kfbxanimcurve.h.

void SetTangentWeightMode	(	KFbxAnimCurveDef::EWeightedMode	pTangentWeightMode,
		KFbxAnimCurveDef::EWeightedMode	pMask = `KFbxAnimCurveDef::eWEIGHTED_ALL`
	)			`[inline]`

Set key tangent weight mode as double value (cubic interpolation, non TCB tangent mode).

Warning: This method is meaningful for cubic interpolation only.

Parameters:

	pTangentWeightMode	Weight mode KFCURVE_WEIGHTED_NONE KFCURVE_WEIGHTED_RIGHT KFCURVE_WEIGHTED_NEXT_LEFT KFCURVE_WEIGHTED_ALL
	pMask	Used to select the affected tangents KFCURVE_WEIGHTED_RIGHT KFCURVE_WEIGHTED_NEXT_LEFT KFCURVE_WEIGHTED_ALL

Definition at line 498 of file kfbxanimcurve.h.

KFbxAnimCurveDef::EVelocityMode GetTangentVelocityMode ( ) const [inline]

Get key tangent velocity mode.

Warning: This method is meaningful for cubic interpolation only. Tangent weight modes are: KFCURVE_VELOCITY_NONE, KFCURVE_VELOCITY_RIGHT, KFCURVE_VELOCITY_NEXT_LEFT, KFCURVE_VELOCITY_ALL

Definition at line 511 of file kfbxanimcurve.h.

void SetTangentVelocityMode	(	KFbxAnimCurveDef::EVelocityMode	pTangentVelocityMode,
		KFbxAnimCurveDef::EVelocityMode	pMask = `KFbxAnimCurveDef::eVELOCITY_ALL`
	)			`[inline]`

Set key tangent velocity mode as double value (cubic interpolation, non TCB tangent mode).

Warning: This method is meaningful for cubic interpolation only.

Parameters:

	pTangentVelocityMode	Weight mode KFCURVE_VELOCITY_NONE KFCURVE_VELOCITY_RIGHT KFCURVE_VELOCITY_NEXT_LEFT KFCURVE_VELOCITY_ALL
	pMask	Used to select the affected tangents KFCURVE_VELOCITY_RIGHT KFCURVE_VELOCITY_NEXT_LEFT KFCURVE_VELOCITY_ALL

Definition at line 528 of file kfbxanimcurve.h.

KFbxAnimCurveDef::EConstantMode GetConstantMode ( ) const [inline]

Get key constant mode.

Warning: This method is meaningful for constant interpolation only. Using this method for non constant interpolated key will return unpredicted value. Constant modes are: KFCURVE_CONSTANT_STANDARD KFCURVE_CONSTANT_NEXT

Returns:: Key constant mode.

Definition at line 540 of file kfbxanimcurve.h.

void SetConstantMode ( KFbxAnimCurveDef::EConstantMode pMode ) [inline]

Set constant mode.

Parameters:

pMode

Constant mode to set.

Definition at line 548 of file kfbxanimcurve.h.

float GetDataFloat ( KFbxAnimCurveDef::EKFbxAnimCurveDataIndex pIndex ) const [inline]

Get data float.

Parameters:

pIndex

Data index, dependent on the key tangent mode.

Returns:: Data value.

Definition at line 557 of file kfbxanimcurve.h.

void SetDataFloat	(	KFbxAnimCurveDef::EKFbxAnimCurveDataIndex	pIndex,
		float	pValue
	)			`[inline]`

Set data float.

Parameters:

	pIndex	Data index, dependent on the key tangent mode.
	pValue	Data value to set.

Definition at line 566 of file kfbxanimcurve.h.

void SetTangentVisibility ( KFbxAnimCurveDef::ETangentVisibility pVisibility ) [inline]

Set tangent visibility mode.

Warning: This method is meaningful for cubic interpolation only.

Parameters:

pVisibility

Tangent visibility mode. Tangent visibility modes are: KFCURVE_TANGEANT_SHOW_NONE KFCURVE_TANGEANT_SHOW_LEFT KFCURVE_TANGEANT_SHOW_RIGHT

Definition at line 578 of file kfbxanimcurve.h.

KFbxAnimCurveDef::ETangentVisibility GetTangentVisibility ( ) const [inline]

Return tangent visibility mode.

Warning: This method is meaningful for cubic interpolation only.

Returns:: Tangent visibility mode. Tangent visibility modes are: KFCURVE_TANGEANT_SHOW_NONE KFCURVE_TANGEANT_SHOW_LEFT KFCURVE_TANGEANT_SHOW_RIGHT

Definition at line 590 of file kfbxanimcurve.h.

void SetBreak ( bool pVal ) [inline]

Set/Unset Break tangent Only valid for User and Auto keys.

Parameters:

pVal

The break flag.

Definition at line 599 of file kfbxanimcurve.h.

bool GetBreak ( ) const [inline]

Get if tangent is break Only valid for User and Auto keys.

Definition at line 607 of file kfbxanimcurve.h.

KFbxAnimCurveKeyImpl* GetImpl ( ) const [inline]

Get key implementation.

Returns:: Pointer to implemented instance, e.g. a KFbxAnimCurveKFCurveKey.

Definition at line 615 of file kfbxanimcurve.h.

Referenced by KFbxAnimCurveKey(), and operator=().

static void SetAllocatorFct ( KFbxAnimCurveKeyImpl *(*)() pAllocatorFct ) [static]

Set allocator function.

Parameters:

pAllocatorFct

Allocator function

static void SetCopyAllocatorFct ( KFbxAnimCurveKeyImpl *(*)(KFbxAnimCurveKeyImpl *) pCopyAllocatorFct ) [static]

Set copy allocator function.

Parameters:

pCopy

AllocatorFct Copy allocator function

static void SetDeallocatorFct ( void(*)(KFbxAnimCurveKeyImpl *) pDeallocatorFct ) [static]

Set deallocator function.

Parameters:

pDeallocatorFct

Deallocator function

KFbxAnimCurveKey Class Reference

Detailed Description

Public Member Functions

Static Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation